home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 2 / Atari Mega Archive CD - Volume 2.iso / 8bit / cislib_a / index2.doc < prev    next >
Text File  |  1995-04-22  |  12KB  |  331 lines
  1.  
  2.  
  3.  
  4.                              INDEX.COM Documentation 
  5.                     Copyright (c) 1985 By The 4th Works, Inc. 
  6.            
  7.            
  8.           NOTE: INDEX.COM REQUIRES THE ATARI PAPERCLIP KEY TO RUN. 
  9.            
  10.                INDEX.COM  is  a  general purpose indexing utility for 
  11.           Atari PaperClip.  It will generate a list of words and page 
  12.           numbers from a word list and a source document. 
  13.            
  14.           1.   CREATING THE INPUT FILES 
  15.            
  16.                Before running INDEX.COM you must create the two files 
  17.           that  it needs to generate an index.  The first file is the 
  18.           INDEX WORD FILE.    It  contains  a list of the words to be 
  19.           indexed,  one  word  per  line  with  a CR after each.  For 
  20.           instance, if you want to index the words 'the', 'and', 'to' 
  21.           and 'from' the INDEX WORD FILE would look like this: 
  22.                      
  23.                     the 
  24.                     and 
  25.                     to 
  26.                     from 
  27.            
  28.                The  words can be in either upper or lower case, since 
  29.           INDEX.COM ignores case.  It converts all words in the index 
  30.           word  list  and  the  source  document into lower case when 
  31.           running.     (You  can  create  the  INDEX WORD FILE  using 
  32.           PaperClip, just press RETURN after each word.) 
  33.            
  34.                The  second  file  you  need  is  the SOURCE FILE.  To 
  35.           generate  this  file,  load  the document you wish to index 
  36.           into  PaperClip.   You must add a special header command to 
  37.           the  file,  so  that  INDEX.COM  will  know what page it is 
  38.           reading.    On  the VERY FIRST line of your source document 
  39.           type: 
  40.                      
  41.                     CTRL-ZH>PAGENUMBER< CTRL-N 
  42.            
  43.                Be sure to use UPPER CASE when typing this.  And don't 
  44.           leave  out the space between the '<' and the CTRL-N.  (Yes, 
  45.           you are supposed to type the '>' and the '<'.) 
  46.                This  tells  PaperClip  to print a header on the first 
  47.           line  of  each  page.  Be sure to use header numbers 2 or 3 
  48.           for  any  other  headers you have defined in your document. 
  49.           (Also  make  sure  that they print on a different line than 
  50.           this header.) 
  51.                Next  press  CTRL-SHIFT-O  (the start output command). 
  52.           When  the  prompt  "Print  device?  P:" prompt appears type 
  53.           "D:filename.ext<RETURN>"   (where   filename.ext   is   the 
  54.           filename  you  wish  to  write to).  Be sure not to use the 
  55.           same  name  as the original copy of the document.  Next you 
  56.           will  be  prompted  "Send control codes? <Y/N> Yes".  Press 
  57.           'N'  then RETURN.  (INDEX.COM will do strange things if you 
  58.           send  printer  control codes to it.)  Just press RETURN for 
  59.           the  rest  of  the prompts.  PaperClip will now "PRINT" the 
  60.           file  to  the  disk  file  you  told  it.    This is is the 
  61.           SOURCE FILE that INDEX.COM needs. 
  62.  
  63.  
  64.  
  65.                                       - 1 - 
  66.  
  67.  
  68.  
  69.  
  70.            
  71.           2.   RUNNING INDEX.COM 
  72.            
  73.                Now  you  are ready to run INDEX.COM.  To do this load 
  74.           your copy of Atari DOS (or DOSXL, or other Atari compatible 
  75.           DOS).  (If you are using an 800XL or 130XE hold down OPTION 
  76.           when  booting DOS.  This will remove the BASIC ROM and give 
  77.           INDEX.COM  8K  of additional memory to store the index in.) 
  78.           When  the  DOS  menu  appars  type  'L<RETURN>',  then type 
  79.           'INDEX.COM<RETURN>'.  (If you are using OS/A+ or DOSXL just 
  80.           type  'INDEX<RETURN>'  at  the D1: prompt.)  This will load 
  81.           and run INDEX.COM. 
  82.            
  83.           NOTE:  Be  sure  your  Atari  PaperClip key is plugged into 
  84.           joystick  port 2.  INDEX.COM will not run if the key is not 
  85.           plugged in. 
  86.            
  87.                After  INDEX.COM  has  loaded  you  will  see the main 
  88.           screen.    This  is  the  screen that says "PaperClip Index 
  89.           Generator"  at  the  top.    It  also will give the version 
  90.           number  of  the  program.  At the bottom of the screen is a 
  91.           number followed by the phrase "Bytes free".  This tells you 
  92.           how much memory INDEX.COM can use to store the index. 
  93.                On  the  same  screen  there  is  also a prompt saying 
  94.           "Index  word  file:".    Type  in  the  name  of  the  file 
  95.           containing the words that are to be indexed (the first file 
  96.           you  created),  and  press RETURN.  (You don't need to type 
  97.           the  "D:",  INDEX.COM will put on the name for you.  If the 
  98.           file  is  not on drive 1, type "Dn:filename.ext", where "n" 
  99.           is  the  drive  number.)    Every  time  you  press RETURN, 
  100.           INDEX.COM  prints  a  status  line at the top of the screen 
  101.           giving the name of the file you just gave it. 
  102.                Next  you  will  be asked to enter the "Source file:". 
  103.           This is the second file you created (the one with the funny 
  104.           header).  Just type in the file name and press RETURN. 
  105.                Finally you will be asked for the "Destination file:". 
  106.           This  is  the  file INDEX.COM will write the index to.  You 
  107.           can  either  have INDEX.COM write the index to a disk file, 
  108.           or to the printer.  To send it directly to the printer type 
  109.           "P:<RETURN>".    To  send  it  to a disk file just type the 
  110.           filename  and press RETURN (just like you did for the other 
  111.           two prompts). 
  112.                When  you press RETURN for the third time, the message 
  113.           "Generating  INDEX  word list." will be printed.  INDEX.COM 
  114.           will then read in the INDEX WORD FILE, and create a list of 
  115.           the  words  to be indexed.  Next a message saying "Indexing 
  116.           source file." will be printed.  INDEX.COM will then read in 
  117.           the  SOURCE FILE  and  generate the index.  As it reads the 
  118.           SOURCE FILE, a message will appear telling you what page it 
  119.           is reading. 
  120.                After  INDEX.COM finishes reading the SOURCE FILE, the 
  121.           message "Writing destination file." will appear.  INDEX.COM 
  122.           will then write the index to the destination file.  (Either 
  123.           the  printer  or the disk file you told it to use.)  At the 
  124.           bottom of the screen there should be a message saying "NNNN 
  125.           Bytes  used".  This lets you know how much of the available 
  126.           memory INDEX.COM used to generate the index. 
  127.  
  128.  
  129.  
  130.  
  131.                                       - 2 - 
  132.  
  133.  
  134.  
  135.  
  136.            
  137.           3.   THE INDEX 
  138.            
  139.                The  index that INDEX.COM generates is an alphabetical 
  140.           list  of  the  words  in the INDEX WORD FILE.  Each word is 
  141.           printed  in  lower case followed by the page number(s) that 
  142.           the  word is on.  The page numbers are seperated by commas. 
  143.           If a word does not occur in the SOURCE FILE no page numbers 
  144.           will be printed after it. 
  145.            
  146.            
  147.           4.   ERROR MESSAGES: 
  148.            
  149.                Whenever  an  error  occurs when running INDEX.COM, an 
  150.           error  message will be printed in the middle of the screen. 
  151.           Some  errors  will also print a prompt saying "Press RETURN 
  152.           to  continue"  at the bottom of the screen.  When you press 
  153.           RETURN,  you  will  get the main screen and the "Index word 
  154.           file:" prompt again. 
  155.            
  156.            
  157.           ---  NOT ENOUGH MEMORY TO STORE THE INDEX WORDS 
  158.                This  message  occurs  when there is not enough memory 
  159.           for  INDEX.COM  to store all the words to be indexed.  When 
  160.           you  press  RETURN  you  will  return to the main INDEX.COM 
  161.           screen.  If this error occurs, first check that there is no 
  162.           cartridge  installed  (on  XL/XE computers make sure OPTION 
  163.           was held down when DOS was booted). 
  164.            
  165.